<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />

  <title>File: README.rdoc [RDoc Documentation]</title>

  <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />

  <script src="./js/jquery.js" type="text/javascript"
    charset="utf-8"></script>
  <script src="./js/thickbox-compressed.js" type="text/javascript"
    charset="utf-8"></script>
  <script src="./js/quicksearch.js" type="text/javascript"
    charset="utf-8"></script>
  <script src="./js/darkfish.js" type="text/javascript"
    charset="utf-8"></script>
</head>

<body class="file">
  <div id="metadata">
    <div id="home-metadata">
      <div id="home-section" class="section">
        <h3 class="section-header">
          <a href="./index.html">Home</a>
          <a href="./index.html#classes">Classes</a>
          <a href="./index.html#methods">Methods</a>
        </h3>
      </div>
    </div>

    <div id="project-metadata">
      
      
      <div id="fileindex-section" class="section project-section">
        <h3 class="section-header">Files</h3>
        <ul>
        
          <li class="file"><a href="./Gemfile.html">Gemfile</a></li>
        
          <li class="file"><a href="./README_rdoc.html">README.rdoc</a></li>
        
        </ul>
      </div>
      

      <div id="classindex-section" class="section project-section">
        <h3 class="section-header">Class Index
          <span class="search-toggle"><img src="./images/find.png"
            height="16" width="16" alt="[+]"
            title="show/hide quicksearch" /></span></h3>
        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
        <fieldset>
          <legend>Quicksearch</legend>
          <input type="text" name="quicksearch" value=""
            class="quicksearch-field" />
        </fieldset>
        </form>

        <ul class="link-list">
        
          <li><a href="./EngineyardAPI.html">EngineyardAPI</a></li>
        
          <li><a href="./EngineyardAPI/Account.html">EngineyardAPI::Account</a></li>
        
          <li><a href="./EngineyardAPI/App.html">EngineyardAPI::App</a></li>
        
          <li><a href="./EngineyardAPI/Engineyard.html">EngineyardAPI::Engineyard</a></li>
        
          <li><a href="./EngineyardAPI/Environment.html">EngineyardAPI::Environment</a></li>
        
          <li><a href="./EngineyardAPI/Instance.html">EngineyardAPI::Instance</a></li>
        
          <li><a href="./Object.html">Object</a></li>
        
        </ul>
        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
      </div>

      
    </div>
  </div>

  <div id="documentation">
    
<h1>Engineyard-API</h1>
<ul><li>
<p><a href="http://tbd">rubyforge rdoc</a></p>
</li><li>
<p><a href="http://tbd">rubyforge project</a></p>
</li><li>
<p><a href="http://github.com/tbd">github project</a></p>
</li></ul>

<h2>Installation</h2>

<p>… will usually be as simple as:</p>

<pre>gem install engineyard-api</pre>

<p>Or, if you downloaded the archive:</p>

<pre>gem build engineyard-api
gem install engineyard-api-&lt;version&gt;</pre>

<h3>Usage &amp; examples</h3>

<h4>Listing instances</h4>

<pre>require 'engineyard-api'
ey = Engineyard.new(&quot;API_KEY&quot;)
environment = ey.environment_by_name(&quot;Production&quot;)
environment.instances.each do |instance|
  puts instance.id
end</pre>

<h5>Multile Accounts</h5>

<pre>require 'engineyard-api'
ey = Engineyard.new(&quot;API_KEY&quot;)
account1_environment = ey.account_by_name(&quot;Account1&quot;).environments.first
account2_environment = ey.account_by_id(1234).environment_by_name(&quot;production&quot;)
last_account_environment = ey.accounts.last.environment_by_id(4567)</pre>

  </div>

  <div id="validator-badges">
    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
      Rdoc Generator</a> 2</small>.</p>
  </div>
</body>
</html>

